<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: Field.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: Field.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>/**
 * @content 字段功能组件
 * @author  2019-09-16
 */
import { NativeModules } from 'react-native';

let FLD = NativeModules.JSField;

import ExtField from './ExtField.js';

/**
 * @class Field
 * @description 字段
 */
export default class Field {
  /**
   * 构造一个新的 Field 对象。
   * @memberOf Field
   * @returns {Promise.&lt;Field>}
   */
  async createObj() {
    try {
      var { FieldId } = await FLD.createObj();
      var field = new Field();
      field._MGFieldId = FieldId;
      return field;
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段名称
   * @memberOf Field
   * @return {String}字段名称
   */
  async getFieldName() {
    try {
      return await FLD.getFieldName(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段名称
   * @memberOf Field
   * @param {String} name 字段名称
   * @return {Promise&lt;void>}
   */
  async setFieldName(name) {
    try {
      await FLD.setFieldName(this._MGFieldId, name);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段类型
   * @memberOf Field
   * @return {Number}字段类型 （int类型的Number）
   */
  async getFieldType() {
    try {
      return await FLD.getFieldType(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段类型
   * @memberOf Field
   * @param {Number} type 字段类型（int类型的Number）
   * @return {Promise&lt;void>}
   */
  async setFieldType(type) {
    try {
      await FLD.setFieldType(this._MGFieldId, type);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段偏移
   * @memberOf Field
   * @return {Number}偏移值 （int类型的Number）
   */
  async getFieldOffset() {
    try {
      return await FLD.getFieldOffset(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段偏移
   * @memberOf Field
   * @param {Number} offset 偏移值（int类型的Number）
   * @return {Promise&lt;void>}
   */
  async setFieldOffset(offset) {
    try {
      await FLD.setFieldOffset(this._MGFieldId, offset);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段字节长度
   * @memberOf Field
   * @return {Number}字节长度 （int类型的Number）
   */
  async getFieldLength() {
    try {
      return await FLD.getFieldLength(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段字节长度
   * @memberOf Field
   * @param {Number} length 字节长度（int类型的Number）
   * @return {Promise&lt;void>}
   */
  async setFieldLength(length) {
    try {
      await FLD.setFieldLength(this._MGFieldId, length);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段字符长度
   * @memberOf Field
   * @return {Number}字段字符长度
   */
  async getMskLength() {
    try {
      return await FLD.getMskLength(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段字符长度
   * @memberOf Field
   * @param {Number} length 字段字符长度
   * @return {Promise&lt;void>}
   */
  async setMskLength(length) {
    try {
      await FLD.setMskLength(this._MGFieldId, length);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取小数位数
   * @memberOf Field
   * @return {Number}小数位数
   */
  async getPointLength() {
    try {
      return await FLD.getPointLength(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置小数位数
   * @memberOf Field
   * @param {Number} length 小数位数
   * @return {Promise&lt;void>}
   */
  async setPointLength(length) {
    try {
      await FLD.setPointLength(this._MGFieldId, length);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取编辑使能标志
   * @memberOf Field
   * @return {Number}使能标志
   */
  async getEditable() {
    try {
      return await FLD.getEditable(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置编辑使能标志
   * @memberOf Field
   * @param {Number} value 使能标志
   * @return {Promise&lt;void>}
   */
  async setEditable(value) {
    try {
      await FLD.setEditable(this._MGFieldId, value);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取打印标志
   * @memberOf Field
   * @return {Number}标志值
   */
  async getPtFlag() {
    try {
      return await FLD.getPtFlag(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置打印标志
   * @memberOf Field
   * @param {Number} flag 标志值
   * @return {Promise&lt;void>}
   */
  async setPtFlag(flag) {
    try {
      await FLD.setPtFlag(this._MGFieldId, flag);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段序号
   * @memberOf Field
   * @return {Number}字段序号值
   */
  async getPtcPosition() {
    try {
      return await FLD.getPtcPosition(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段序号
   * @memberOf Field
   * @param {Number} position 字段序号值
   * @return {Promise&lt;void>}
   */
  async setPtcPosition(position) {
    try {
      await FLD.setPtcPosition(this._MGFieldId, position);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 获取字段是否继承标志
   * @memberOf Field
   * @return {Number}继承标志值
   */
  async getIsInherited() {
    try {
      return await FLD.getIsInherited(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置字段是否继承标志
   * @memberOf Field
   * @param {Number} value 继承标志值
   * @return {Promise&lt;void>}
   */
  async setIsInherited(value) {
    try {
      await FLD.setIsInherited(this._MGFieldId, value);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 计算字段头需要占用的存储空间
   * @memberOf Field
   * @return {Number}占用空间值
   */
  async CalculateSize() {
    try {
      return await FLD.CalculateSize(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 取扩展字段信息
   * @memberOf Field
   * @return {Promise&lt;ExtField>}扩展字段对象
   */
  async getExtField() {
    try {
      let { ExtFieldId } = await FLD.getExtField(this._MGFieldId);
      var extField = new ExtField();
      extField._MGExtFieldId = ExtFieldId;
      return extField;
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 设置扩展字段信息
   * @memberOf Field
   * @param fieldEx 扩展字段对象
   * @return {Promise&lt;void>}
   */
  async setExtField(fieldEx) {
    try {
      await FLD.setExtField(this._MGFieldId, fieldEx._MGExtFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 是否有扩展字段
   * @memberOf Field
   * @return {Number} 非0/0 ：是/否
   */
  async hasExtField() {
    try {
      return await FLD.hasExtField(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }

  /**
   * 删除扩展字段
   * @memberOf Field
   * @return {Number} 大于0成功，否则失败
   */
  async deleteExtField() {
    try {
      return await FLD.deleteExtField(this._MGFieldId);
    } catch (e) {
      console.error(e);
    }
  }
}
</code></pre>
        </article>
    </section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnnClsInfo.html">AnnClsInfo</a></li><li><a href="AnnInfo.html">AnnInfo</a></li><li><a href="Annotation.html">Annotation</a></li><li><a href="AnnotationCls.html">AnnotationCls</a></li><li><a href="AnnotationsOverlay.html">AnnotationsOverlay</a></li><li><a href="AnnotationView.html">AnnotationView</a></li><li><a href="BasCls.html">BasCls</a></li><li><a href="ClassItemValue.html">ClassItemValue</a></li><li><a href="CoordinateConvert.html">CoordinateConvert</a></li><li><a href="CoordinateConvertParameter.html">CoordinateConvertParameter</a></li><li><a href="CrossData.html">CrossData</a></li><li><a href="DataBase.html">DataBase</a></li><li><a href="DataBaseSync.html">DataBaseSync</a></li><li><a href="Document.html">Document</a></li><li><a href="DocumentItem.html">DocumentItem</a></li><li><a href="Dot.html">Dot</a></li><li><a href="Dot3D.html">Dot3D</a></li><li><a href="Dots.html">Dots</a></li><li><a href="Dots3D.html">Dots3D</a></li><li><a href="DownloadDataBaseParmeters.html">DownloadDataBaseParmeters</a></li><li><a href="DownloadLayerOption.html">DownloadLayerOption</a></li><li><a href="ElpParam.html">ElpParam</a></li><li><a href="ElpTransformation.html">ElpTransformation</a></li><li><a href="ElpTransParam.html">ElpTransParam</a></li><li><a href="Environment.html">Environment</a></li><li><a href="ExtField.html">ExtField</a></li><li><a href="FClsInfo.html">FClsInfo</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FeatureEdit.html">FeatureEdit</a></li><li><a href="FeaturePagedResult.html">FeaturePagedResult</a></li><li><a href="FeatureQuery.html">FeatureQuery</a></li><li><a href="FeatureSync.html">FeatureSync</a></li><li><a href="Field.html">Field</a></li><li><a href="Fields.html">Fields</a></li><li><a href="FillStyle.html">FillStyle</a></li><li><a href="GeneralVectorLabel.html">GeneralVectorLabel</a></li><li><a href="GeoAnno.html">GeoAnno</a></li><li><a href="GeoLine.html">GeoLine</a></li><li><a href="GeoLines.html">GeoLines</a></li><li><a href="Geometry.html">Geometry</a></li><li><a href="GeometryExp.html">GeometryExp</a></li><li><a href="GeometryParams.html">GeometryParams</a></li><li><a href="GeomInfo.html">GeomInfo</a></li><li><a href="GeoPoints.html">GeoPoints</a></li><li><a href="GeoPolygon.html">GeoPolygon</a></li><li><a href="GeoPolygons.html">GeoPolygons</a></li><li><a href="GeoVarLine.html">GeoVarLine</a></li><li><a href="Graphic.html">Graphic</a></li><li><a href="GraphicCircle.html">GraphicCircle</a></li><li><a href="GraphicHeatmap.html">GraphicHeatmap</a></li><li><a href="GraphicImage.html">GraphicImage</a></li><li><a href="GraphicMultiPoint.html">GraphicMultiPoint</a></li><li><a href="GraphicPoint.html">GraphicPoint</a></li><li><a href="GraphicPolygon.html">GraphicPolygon</a></li><li><a href="GraphicPolylin.html">GraphicPolylin</a></li><li><a href="GraphicsOverlay.html">GraphicsOverlay</a></li><li><a href="GraphicsOverlays.html">GraphicsOverlays</a></li><li><a href="GraphicStippleLine.html">GraphicStippleLine</a></li><li><a href="GraphicText.html">GraphicText</a></li><li><a href="GroupLayer.html">GroupLayer</a></li><li><a href="HeatmapPoint.html">HeatmapPoint</a></li><li><a href="Image.html">Image</a></li><li><a href="IntUser.html">IntUser</a></li><li><a href="Label.html">Label</a></li><li><a href="LabelInfo.html">LabelInfo</a></li><li><a href="LatLng.html">LatLng</a></li><li><a href="LayerEnum.html">LayerEnum</a></li><li><a href="LinePlaceInfo.html">LinePlaceInfo</a></li><li><a href="LineStyle.html">LineStyle</a></li><li><a href="LinInfo.html">LinInfo</a></li><li><a href="MagnifierOption.html">MagnifierOption</a></li><li><a href="Map.html">Map</a></li><li><a href="MapLayer.html">MapLayer</a></li><li><a href="MapPosition.html">MapPosition</a></li><li><a href="Maps.html">Maps</a></li><li><a href="MapServer.html">MapServer</a></li><li><a href="MapServiceInfo.html">MapServiceInfo</a></li><li><a href="MapServiceLayerInfo.html">MapServiceLayerInfo</a></li><li><a href="MapView.html">MapView</a></li><li><a href="MeasureContentWillChangeListener.html">MeasureContentWillChangeListener</a></li><li><a href="MeasureOption.html">MeasureOption</a></li><li><a href="Model.html">Model</a></li><li><a href="ModelsOverlay.html">ModelsOverlay</a></li><li><a href="MultiClassTheme.html">MultiClassTheme</a></li><li><a href="MultiClassThemeInfo.html">MultiClassThemeInfo</a></li><li><a href="OGCWMTSMapServer.html">OGCWMTSMapServer</a></li><li><a href="PntInfo.html">PntInfo</a></li><li><a href="PointF.html">PointF</a></li><li><a href="PointPlaceInfo.html">PointPlaceInfo</a></li><li><a href="PointStyle.html">PointStyle</a></li><li><a href="QueryBound.html">QueryBound</a></li><li><a href="QueryDef.html">QueryDef</a></li><li><a href="RangeTheme.html">RangeTheme</a></li><li><a href="RangeThemeInfo.html">RangeThemeInfo</a></li><li><a href="Record.html">Record</a></li><li><a href="RecordSet.html">RecordSet</a></li><li><a href="Rect.html">Rect</a></li><li><a href="RegInfo.html">RegInfo</a></li><li><a href="RegionPlaceInfo.html">RegionPlaceInfo</a></li><li><a href="ServerLayer.html">ServerLayer</a></li><li><a href="SFeatureCls.html">SFeatureCls</a></li><li><a href="SimpleLabel.html">SimpleLabel</a></li><li><a href="SimpleModelLayer.html">SimpleModelLayer</a></li><li><a href="SimpleModelLayerUtil.html">SimpleModelLayerUtil</a></li><li><a href="SimpleTheme.html">SimpleTheme</a></li><li><a href="SketchEditor.html">SketchEditor</a></li><li><a href="SketchStyle.html">SketchStyle</a></li><li><a href="SnappingOption.html">SnappingOption</a></li><li><a href="SpaAnalysis.html">SpaAnalysis</a></li><li><a href="SpaCalculator.html">SpaCalculator</a></li><li><a href="SpaProjection.html">SpaProjection</a></li><li><a href="SpaRelation.html">SpaRelation</a></li><li><a href="SRefData.html">SRefData</a></li><li><a href="SyncBase.html">SyncBase</a></li><li><a href="SyncDataBaseParmeters.html">SyncDataBaseParmeters</a></li><li><a href="SyncLayerOption.html">SyncLayerOption</a></li><li><a href="TextAnnInfo.html">TextAnnInfo</a></li><li><a href="TextAnno.html">TextAnno</a></li><li><a href="TextStyle.html">TextStyle</a></li><li><a href="Theme.html">Theme</a></li><li><a href="ThemeInfo.html">ThemeInfo</a></li><li><a href="Themes.html">Themes</a></li><li><a href="TileMapServer.html">TileMapServer</a></li><li><a href="UniqueTheme.html">UniqueTheme</a></li><li><a href="UniqueThemeInfo.html">UniqueThemeInfo</a></li><li><a href="VectorCls.html">VectorCls</a></li><li><a href="VectorLabel.html">VectorLabel</a></li><li><a href="VectorLayer.html">VectorLayer</a></li><li><a href="VectorMapServer.html">VectorMapServer</a></li><li><a href="VectorTheme.html">VectorTheme</a></li><li><a href="VectorTileMapServer.html">VectorTileMapServer</a></li><li><a href="VisualMap.html">VisualMap</a></li><li><a href="XClsInfo.html">XClsInfo</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addAnnotation">addAnnotation</a></li><li><a href="global.html#addAnnotations">addAnnotations</a></li><li><a href="global.html#animatePosition">animatePosition</a></li><li><a href="global.html#distanceOfGeometry">distanceOfGeometry</a></li><li><a href="global.html#getAllAnnotations">getAllAnnotations</a></li><li><a href="global.html#getAnnotation">getAnnotation</a></li><li><a href="global.html#getAnnotationCount">getAnnotationCount</a></li><li><a href="global.html#getGeometryByType">getGeometryByType</a></li><li><a href="global.html#indexOf">indexOf</a></li><li><a href="global.html#initialize">initialize</a></li><li><a href="global.html#moveAnnotation">moveAnnotation</a></li><li><a href="global.html#removeAllAnnotations">removeAllAnnotations</a></li><li><a href="global.html#removeAnnotation">removeAnnotation</a></li><li><a href="global.html#removeAnnotationByIndex">removeAnnotationByIndex</a></li><li><a href="global.html#removeAnnotations">removeAnnotations</a></li><li><a href="global.html#requestAuthorization">requestAuthorization</a></li><li><a href="global.html#setResolution">setResolution</a></li><li><a href="global.html#setScale">setScale</a></li><li><a href="global.html#setSize">setSize</a></li><li><a href="global.html#setSystemLibraryPath">setSystemLibraryPath</a></li><li><a href="global.html#toGeometry">toGeometry</a></li><li><a href="global.html#toGeometrys">toGeometrys</a></li><li><a href="global.html#toGraphicsFromGeometry">toGraphicsFromGeometry</a></li><li><a href="global.html#updatePositionbyViewPoint">updatePositionbyViewPoint</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Fri Jan 17 2020 16:23:46 GMT+0800 (GMT+08:00)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
